Fix missing includes by astrojuanlu · Pull Request #275 · musescore/muse_framework

astrojuanlu · 2026-09-06T09:03:32Z

Resolves: #272
Resolves: #273
Resolves: #274

Full context in the issue reports and commit messages.

I signed the CLA as username:
The title of the PR describes the problem it addresses.
Each commit's message describes its purpose and effects, and references the issue it resolves. If changes are extensive, there is a sequence of easily reviewable commits.
The code in the PR follows the coding rules.
I understand all aspects of the code I'm contributing and I'm able to explain it if requested.
The code compiles and runs on my machine, preferably after each commit individually. I have manually tested and verified that my changes fulfil their intended purpose.
No prior attempts to resolve this problem exist, or if they do, I listed them in my PR description and described how I avoided repeating past mistakes.
There are no unnecessary changes.
I created a unit test or vtest to verify the changes I made (if applicable).

Build configuration

audacity: audacity/audacity/master
audacity platforms: linux_x64
musescore: musescore/MuseScore/main
musescore platforms: linux_x64

coderabbitai · 2026-09-06T09:20:05Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 856268e5-67c6-4a25-84fc-b82d1d6b0154

📥 Commits

Reviewing files that changed from the base of the PR and between a3d1363 and c8acff7.

📒 Files selected for processing (4)

framework/dockwindow/thirdparty/KDDockWidgets/src/DockWidgetBase.cpp
framework/extensions/api/v1/extapiv1.cpp
framework/extensions/internal/extensionsession.h
framework/ui/uimodule.cpp

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

Added missing header includes to framework source files. The changes add QAction to DockWidgetBase.cpp, QQmlEngine to the extensions API and UI module sources, and extensionstypes.h to extensionsession.h. No public declarations or runtime logic changed.

Merge Risk: ⚪ Minimal · up to 98ebb

This change restores explicit Qt and extension-type header dependencies so the framework no longer relies on transitive includes, without changing runtime behavior. No current merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The changes address parts of issues [`#272`], [`#273`], and [`#274`], including `extensionstypes.h`, `QQmlEngine`, and `QAction`. However, the linked issues list additional required includes and affected fi…	Add all remaining include directives required by issues [`#272`] and [`#273`]. Remove the obsolete `QFile` forward declaration after adding `<QFile>`. Verify the listed affected files and confirm that the framework builds without relying on tra…
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 4 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately identifies the primary change: adding missing include directives.
Description check	✅ Passed	The description references all linked issues, explains the motivation, completes the checklist, and provides build configuration. The unchecked test item is acceptable if tests are not applicable.
Out of Scope Changes check	✅ Passed	All reported changes are include-only changes that directly support the requirements in issues [`#272`], [`#273`], and [`#274`]. No unrelated code changes are shown.

Full details: Linked Issues check

Explanation

The changes address parts of issues [#272], [#273], and [#274], including extensionstypes.h, QQmlEngine, and QAction. However, the linked issues list additional required includes and affected files that are not present in the provided changes, including <QFile>, <QVariant>, <QTimer>, <QMetaEnum>, <QWindow>, <QJSEngine>, and others.

Resolution

Add all remaining include directives required by issues [#272] and [#273]. Remove the obsolete QFile forward declaration after adding <QFile>. Verify the listed affected files and confirm that the framework builds without relying on transitive Qt includes.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

astrojuanlu · 2026-09-06T09:26:09Z

Most of the include fixes were already addressed by #256, which is newer than the vendored version in Audacity 4 at the time of opening this PR. So the CodeRabbit feedback is not applicable.

extensionsession.h uses 'const Manifest&' as a parameter type but only includes iextensionsession.h and scriptengine.h, neither of which provides the Manifest definition (declared in extensionstypes.h). This compiles only when extensionstypes.h is transitively included through other headers, which varies between Qt distributions. Closes musescore#272 Assisted-by: OpenRouter:z-ai/glm-5.2 opencode

extapiv1.cpp and uimodule.cpp call qmlRegisterType() and qmlRegisterSingletonType() without including <QQmlEngine>, which declares these functions in Qt 6. The calls compile only when <QQmlEngine> is transitively included through other headers, which varies between Qt distributions. Closes musescore#273 Assisted-by: OpenRouter:z-ai/glm-5.2 opencode

…getBase.cpp DockWidgetBase.cpp calls methods on QAction objects (e.g. setEnabled(), triggered signal) but does not include <QAction>. The code compiles only when <QAction> is transitively included through other QtGui headers, which varies between Qt distributions. This is already fixed in upstream KDDockWidgets 2.x, but the vendored snapshot is 1.4.95. Closes musescore#274 Assisted-by: OpenRouter:z-ai/glm-5.2 opencode

luapmartin · 2026-09-18T11:00:45Z

Thanks @astrojuanlu

Missing #include directives for Qt types used by value or in template instantiations #272: almost fully covered by Make sources self-contained without PCH and unity builds #256
qmlRegisterType and related functions not declared - missing #include <QQmlEngine> #273: files no longer call qmlRegister* (or now include <qqml.h>).
Vendored KDDockWidgets: DockWidgetBase.cpp missing #include <QAction> #274: DockWidgetBase_p.h already brings in <QAction>, so I couldn't reproduce it on current main.

Audacity side, we now have: audacity/audacity#12178 and audacity/audacity#12189

I just rebased on main, could you please test again with your KDE Qt?

If anything still fails, please paste the compile error and we'll take a look. Otherwise I'd suggest closing #272/#273 (and this PR) as addressed, and keeping #274 open until you can confirm from your KDE Qt test.

luapmartin · 2026-09-29T09:47:40Z

Hi @astrojuanlu did you had a chance to try with your KDE Qt setup? thanks

astrojuanlu · 2026-09-30T17:35:21Z

Sorry @luapmartin , I did not have a chance to try this and I might need a few days to get back to it. I see you're already merging some PRs, if they supersede this one feel free to close. I'll try to get back to you soon, but don't wait for me. Thanks!

luapmartin · 2026-10-01T15:10:01Z

ok, let's do this then, I am going to close those (#272 , #273 , #274 ) and please if you still face some issue re-open or create new issue referencing those previous issues and ping me, thanks.

astrojuanlu marked this pull request as ready for review September 6, 2026 09:17

astrojuanlu mentioned this pull request Sep 6, 2026

Audacity 4 snapcrafters/audacity#94

Draft

astrojuanlu added 3 commits September 18, 2026 12:52

luapmartin force-pushed the fix/missing-includes-qt-transitive branch from c8acff7 to 98ebb6e Compare September 18, 2026 10:52

luapmartin mentioned this pull request Sep 21, 2026

Builds without PCH / unity are broken and nothing in CI notices audacity/audacity#12247

Closed

luapmartin closed this Oct 1, 2026

astrojuanlu deleted the fix/missing-includes-qt-transitive branch October 2, 2026 09:10

Navigation Menu

Fix missing includes - #275

Fix missing includes#275
astrojuanlu wants to merge 3 commits into
musescore:mainfrom
astrojuanlu:fix/missing-includes-qt-transitive

astrojuanlu commented Sep 6, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Sep 6, 2026 •

edited

Loading

Walkthrough

❌ Failed checks (2 warnings)

Uh oh!

astrojuanlu commented Sep 6, 2026

Uh oh!

luapmartin commented Sep 18, 2026

Uh oh!

luapmartin commented Sep 29, 2026

Uh oh!

astrojuanlu commented Sep 30, 2026

Uh oh!

luapmartin commented Oct 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

astrojuanlu commented Sep 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Build configuration

Uh oh!

coderabbitai Bot commented Sep 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

❌ Failed checks (2 warnings)

Uh oh!

astrojuanlu commented Sep 6, 2026

Uh oh!

luapmartin commented Sep 18, 2026

Uh oh!

luapmartin commented Sep 29, 2026

Uh oh!

astrojuanlu commented Sep 30, 2026

Uh oh!

luapmartin commented Oct 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

astrojuanlu commented Sep 6, 2026 •

edited

Loading

coderabbitai Bot commented Sep 6, 2026 •

edited

Loading